/*
 * MIT License
 *
 * Copyright (c) 2024-2048 冰羽
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package cn.star.framework.core;

import cn.hutool.core.util.StrUtil;
import java.util.List;
import java.util.function.BiPredicate;
import java.util.function.Predicate;
import org.springframework.cache.Cache;

/**
 * 缓存接口<br>
 * 过期时间单位：秒<br>
 *
 * @author zhaoweiping
 *     <p style='color: red'>Created on 2024-09-23 11:06:00
 * @since 3.0.0
 */
public interface ICache {

  /**
   * 获取所有的Cache {@link Cache}
   *
   * @return 缓存
   */
  List<Cache> get();

  /**
   * 根据名称获取缓存Cache {@link Cache}
   *
   * @param key 缓存名称
   * @return 缓存
   */
  Cache get(String key);

  /**
   * 根据缓存名称中的键获取值(值可以是单体也可以是集合)
   *
   * @param cacheName 缓存名称
   * @param key 键
   * @param <T> 值类型
   * @return 值
   */
  <T> T get(String cacheName, String key);

  /**
   * 根据缓存名称中的键设置值
   *
   * @param cacheName 缓存名称
   * @param key 键
   * @param value 值
   * @param <T> 值类型
   */
  default <T> void set(String cacheName, String key, T value) {
    set(cacheName, key, value, -1);
  }

  /**
   * 根据缓存名称中的键设置值
   *
   * @param cacheName 缓存名称
   * @param key 键
   * @param value 值
   * @param expire 过期时间(TTL)
   * @param <T> 值类型
   */
  <T> void set(String cacheName, String key, T value, long expire);

  /**
   * 根据缓存名称中的键设置值
   *
   * @param cacheName 缓存名称
   * @param key 键
   * @param values 值
   * @param predicate 值比较函数
   * @param <T> 值类型
   */
  default <T> void set(String cacheName, String key, List<T> values, BiPredicate<T, T> predicate) {
    set(cacheName, key, values, predicate, -1);
  }

  /**
   * 根据缓存名称中的键设置值
   *
   * @param cacheName 缓存名称
   * @param key 键
   * @param values 值
   * @param predicate 值比较函数
   * @param expire 过期时间(TTL)
   * @param <T> 值类型
   */
  default <T> void set(
      String cacheName, String key, List<T> values, BiPredicate<T, T> predicate, long expire) {
    set(cacheName, key, values, predicate, false, -1);
  }

  /**
   * 根据缓存名称中的键设置值
   *
   * @param cacheName 缓存名称
   * @param key 键
   * @param values 值
   * @param predicate 值比较函数
   * @param headerAppend 是否在头部(列表开头)追加
   * @param <T> 值类型
   */
  default <T> void set(
      String cacheName,
      String key,
      List<T> values,
      BiPredicate<T, T> predicate,
      boolean headerAppend) {
    set(cacheName, key, values, predicate, headerAppend, -1);
  }

  /**
   * 根据缓存名称中的键设置值
   *
   * @param cacheName 缓存名称
   * @param key 键
   * @param values 值
   * @param predicate 值比较函数
   * @param headerAppend 是否在头部(列表开头)追加, 否则追加在尾部
   * @param expire 过期时间(TTL)
   * @param <T> 值类型
   */
  <T> void set(
      String cacheName,
      String key,
      List<T> values,
      BiPredicate<T, T> predicate,
      boolean headerAppend,
      long expire);

  /**
   * 根据缓存名称清除缓存
   *
   * @param cacheName 缓存名称
   */
  void clear(String cacheName);

  /**
   * 根据缓存名称中键清除缓存
   *
   * @param cacheName 缓存名称
   * @param key 键
   * @param <T> 值类型
   * @return 值
   */
  <T> T clear(String cacheName, String key);

  /**
   * 根据缓存名称中键清除缓存
   *
   * @param cacheName 缓存名称
   * @param key 键
   * @param predicate 过滤函数
   * @param <T> 值类型
   * @return 值
   */
  <T> List<T> clear(String cacheName, String key, Predicate<? extends T> predicate);

  /**
   * 判断是否存在
   *
   * @param cacheName 缓存名称
   * @param key 键
   * @return
   */
  default boolean exist(String cacheName, String key) {
    return get(cacheName, key) != null;
  }

  /**
   * 获取默认规则生成的CacheName
   *
   * @param clazz 使用 {@link ICache} 的类
   * @return
   */
  static String getDefaultCacheName(Class<?> clazz) {
    return StrUtil.format("__{}__", clazz.getName());
  }
}
